﻿#region Copyright (c) 2003 - 2008, Andreas Mueller
/////////////////////////////////////////////////////////////////////////////////////////
// 
// Copyright (c) 2003 - 2008, Andreas Mueller.
// All rights reserved. This program and the accompanying materials
// are made available under the terms of the Eclipse Public License v1.0
// which accompanies this distribution, and is available at
// http://www.eclipse.org/legal/epl-v10.html
//
// Contributors:
//    Andreas Mueller - initial API and implementation
//
// 
// This software is derived from software bearing the following
// restrictions:
// 
// Copyright (c) 1994
// Hewlett-Packard Company
// 
// Permission to use, copy, modify, distribute and sell this software
// and its documentation for any purpose is hereby granted without fee,
// provided that the above copyright notice appear in all copies and
// that both that copyright notice and this permission notice appear
// in supporting documentation.  Hewlett-Packard Company makes no
// representations about the suitability of this software for any
// purpose.  It is provided "as is" without express or implied warranty.
// 
// 
// Copyright (c) 1996,1997
// Silicon Graphics Computer Systems, Inc.
// 
// Permission to use, copy, modify, distribute and sell this software
// and its documentation for any purpose is hereby granted without fee,
// provided that the above copyright notice appear in all copies and
// that both that copyright notice and this permission notice appear
// in supporting documentation.  Silicon Graphics makes no
// representations about the suitability of this software for any
// purpose.  It is provided "as is" without express or implied warranty.
// 
// 
// (C) Copyright Nicolai M. Josuttis 1999.
// Permission to copy, use, modify, sell and distribute this software
// is granted provided this copyright notice appears in all copies.
// This software is provided "as is" without express or implied
// warranty, and with no claim as to its suitability for any purpose.
// 
/////////////////////////////////////////////////////////////////////////////////////////
#endregion


using System.Collections;
using NStl.Iterators;
using NUnit.Framework;

namespace NStl.NUnit.Support
{
    /// <summary>
    /// An abstract fixture to test any <see cref="IForwardIterator{T}"/> implementation.
    /// </summary>
    /// <typeparam name="T"></typeparam>
    public abstract class ForwardIteratorFixture<T> : InputIteratorFixture<T>
    {
        protected sealed override IInputIterator<T> CreateInputBegin()
        {
            return CreateFwdBegin();
        }

        protected sealed override IInputIterator<T> CreateInputEnd()
        {
            return CreateFwdEnd();
        }

        protected abstract IForwardIterator<T> CreateFwdBegin();

        protected abstract IForwardIterator<T> CreateFwdEnd();

        protected IForwardIterator<T> fwdBegin;
        protected IForwardIterator<T> fwdEnd;
        
        [SetUp]
        public override void SetUp()
        {
            base.SetUp();
            fwdBegin = (IForwardIterator<T>) begin;
            fwdEnd = (IForwardIterator<T>)end;
        }

        [Test]
        public void CloneFwdItWhenMovedBefore()
        {
            fwdBegin.PreIncrement();
            fwdBegin.PostIncrement();

            Assert.AreEqual(referenceArray[2], fwdBegin.Value);

            IForwardIterator<T> itClone = (IForwardIterator<T>)fwdBegin.Clone();
            Assert.AreEqual(referenceArray[2], itClone.Value);
        }

        [Test]
        public void PreIncrementFwdIt()
        {
            IForwardIterator<T> other = fwdBegin.PreIncrement();
            Assert.AreSame(other, fwdBegin);
            Assert.AreEqual(other, fwdBegin);
            Assert.AreEqual(referenceArray[1], other.Value);
        }

        [Test]
        public void PostIncrementFwdIt()
        {
            IForwardIterator<T> other = fwdBegin.PostIncrement();
            Assert.AreNotSame(other, fwdBegin);
            Assert.AreNotEqual(other, fwdBegin);

            Assert.AreEqual(referenceArray[0], other.Value);
            Assert.AreEqual(referenceArray[1], fwdBegin.Value);
        }

        [Test]
        public void IterateAndReadValue()
        {
            ArrayList target = new ArrayList();
            while (!fwdBegin.Equals(fwdEnd))
            {
                target.Add(fwdBegin.Value);
                fwdBegin.PreIncrement();
            }

            fwdBegin = CreateFwdBegin();
            CollectionAssert.AreEqual(NStlUtil.Collection(fwdBegin, fwdEnd), target);
        }
        [Test]
        public void IterateAndWriteValue()
        {
            ArrayList expected = new ArrayList();
            while (!fwdBegin.Equals(fwdEnd))
            {
                T t = default(T);
                fwdBegin.Value = t;
                fwdBegin.PreIncrement();
                expected.Add(t);
            }

            fwdBegin = CreateFwdBegin();
            CollectionAssert.AreEqual(expected, NStlUtil.Collection(fwdBegin, fwdEnd));
        }

        [Test]
        public void IteratePartial()
        {
            fwdBegin = NStlUtil.Advance<T, IForwardIterator<T>>(fwdBegin, 3);
            IForwardIterator<T> clonedBegin = (IForwardIterator<T>)fwdBegin.Clone();
            
            ArrayList target = new ArrayList();
            while (!fwdBegin.Equals(fwdEnd))
            {
                target.Add(fwdBegin.Value);
                fwdBegin.PreIncrement();
            }

            CollectionAssert.AreEqual(NStlUtil.Collection(clonedBegin, fwdEnd), target);
        }
        //[Test]
        //[ExpectedException(typeof(DereferenceEndIteratorException))]
        //public void DereferenceEndIterator()
        //{
        //    NeverCalled(fwdEnd.Value);// should throw DereferenceEndIteratorException!!
        //}
        //[Test]
        //public void MoveBehindEnd()
        //{
        //    // ... In C++ it is possible to move behind the end and back! Deref is unefined
        //    fwdEnd.PostIncrement();
        //}
    }
}
